DOC-5931 "hierarchy" diagram hook #2365
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Contributor
Contributor
|
For an idea of where these could go: Adding schema info for REST API examples. It would be cool if I could have used these here instead of using a table for the POST schema. |
Contributor
Author
|
OK, added some simple docs in the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a simple YAML format to generate filesystem or class hierarchy diagrams (this is another example of where AI benefits from a text format rather than a drawn diagram or ASCII art). I've added a couple of examples of where this could be used, but there are probably a few more in the docs.
All feedback is welcome (format, styling, icons in the filesystem example, etc). I'll add some docs for the YAML format too, once we're happy with it.